Skip to content

docs(adk): audit foundations and concept pages#444

Open
jacksonyzj wants to merge 24 commits intomasterfrom
feat/update-adk-docs
Open

docs(adk): audit foundations and concept pages#444
jacksonyzj wants to merge 24 commits intomasterfrom
feat/update-adk-docs

Conversation

@jacksonyzj
Copy link
Copy Markdown

@jacksonyzj jacksonyzj commented Apr 1, 2026

Summary

Audit and update all foundation and concept pages to match ADK v1.17. Verified against runtime source code (agent-lack repo) and shipped @botpress/runtime@1.17.0 types.

Tickets

# Ticket Page
1 ADK-287 Introduction
2 ADK-288 Quickstart
3 ADK-289 Project Structure
4 ADK-292 Conversations
5 ADK-290 Actions
6 ADK-294 Tables
7 ADK-295 Triggers
8 ADK-296 Knowledge
9 ADK-291 Tools
10 ADK-293 Workflows (merged 2 pages → 1)

Key changes

  • Fixed inaccurate code examples and API signatures
  • Removed non-existent APIs and unreleased features
  • Added missing documentation for shipped features
  • Merged the two workflow pages into one
  • Updated quickstart to match current adk init flow

See individual Linear tickets for detailed change lists.

Test plan

  • Preview via Mintlify staging deployment
  • Cross-check all code examples against @botpress/runtime@1.17.0 shipped types
  • Verified all internal links resolve
  • Tested by separate AI agent reading local .mdx files against running ADK bot

@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 1, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
botpress 🟢 Ready View Preview Apr 1, 2026, 12:29 AM

@jacksonyzj jacksonyzj changed the title docs(adk): update ADK documentation docs(adk): audit existing pages — foundation + concepts (PR 1) Apr 1, 2026
@jacksonyzj jacksonyzj changed the title docs(adk): audit existing pages — foundation + concepts (PR 1) docs(adk): audit foundations and concept pages Apr 1, 2026
@aj-botpress
Copy link
Copy Markdown

Gonna spam comments, feel free to resolve!

image

Not exactly. Looking at the actual code:

  1. No default export required — The ADK uses expandExports to scan all named exports from conversation files (line 860-866), not just default. The
    example in lack uses a named export (export const AllChat), not export default.
  2. Auto-discovery is true — The ADK does scan all .ts/.js files in the conversations directory, checks each export with
    Primitives.Definitions.isConversationDefinition(), and registers any that are valid Conversation instances (lines 888-915).

@aj-botpress
Copy link
Copy Markdown

image

Actions are also callable from outside the agent via the Botpress API.

The generated AdkClient (client-wrapper.ts:346-358) wraps client.callAction() — which is a Botpress API call. So any external system with a valid bot
client can invoke actions the same way:

client.callAction({ type: 'lookupOrder', input: { orderId: '123' } })

Additionally, adk run scripts can call actions from outside the normal agent runtime (via the actions proxy in actions.ts, which also uses
client.callAction for integration actions).

So the accurate statement would be: Actions are callable from workflows, conversations, other actions, external API clients, and ADK scripts.

@aj-botpress
Copy link
Copy Markdown

Would be nice to tie into Control Panel Stuff with the primitives:
i.e.

Invoking / testing actions and workflows from the control panel
interacting with tables on dev and prod in the tables view, managing sync status and sync requests,
etc

@aj-botpress
Copy link
Copy Markdown

image we should prompt them to open up the control panel earlier.

would be nice to also introduce them to the agentsteps screen here.

@aj-botpress
Copy link
Copy Markdown

image no evals?

@aj-botpress
Copy link
Copy Markdown

image Should this be part of project structure?

Copy link
Copy Markdown
Collaborator

@chloequijano-botpress chloequijano-botpress left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some more feedback after taking a second look

@jacksonyzj
Copy link
Copy Markdown
Author

Gonna spam comments, feel free to resolve!

image Not exactly. Looking at the actual code:
  1. No default export required — The ADK uses expandExports to scan all named exports from conversation files (line 860-866), not just default. The
    example in lack uses a named export (export const AllChat), not export default.
  2. Auto-discovery is true — The ADK does scan all .ts/.js files in the conversations directory, checks each export with
    Primitives.Definitions.isConversationDefinition(), and registers any that are valid Conversation instances (lines 888-915).

Good catch, fixed! Updated to say the ADK discovers all exported Conversation instances (default or named).

@jacksonyzj
Copy link
Copy Markdown
Author

Actions are also callable from outside the agent via the Botpress API.

The generated AdkClient (client-wrapper.ts:346-358) wraps client.callAction() — which is a Botpress API call. So any external system with a valid bot client can invoke actions the same way:

client.callAction({ type: 'lookupOrder', input: { orderId: '123' } })

Additionally, adk run scripts can call actions from outside the normal agent runtime (via the actions proxy in actions.ts, which also uses client.callAction for integration actions).

So the accurate statement would be: Actions are callable from workflows, conversations, other actions, external API clients, and ADK scripts.

Fixed!

@jacksonyzj
Copy link
Copy Markdown
Author

Would be nice to tie into Control Panel Stuff with the primitives: i.e.

Invoking / testing actions and workflows from the control panel interacting with tables on dev and prod in the tables view, managing sync status and sync requests, etc

Noted! Will add these cross references as soon as add the control panel page!

@jacksonyzj
Copy link
Copy Markdown
Author

we should prompt them to open up the control panel earlier.
would be nice to also introduce them to the agentsteps screen here.

No evals yet in this release! We can wait it till next release to add it!

@jacksonyzj
Copy link
Copy Markdown
Author

image we should prompt them to open up the control panel earlier.
would be nice to also introduce them to the agentsteps screen here.

Good suggestions! I moved the control panel above adk chat, also include a screenshot for agent steps.

@jacksonyzj
Copy link
Copy Markdown
Author

image Should this be part of project structure?

I put it here as a quick intro since it ties to agent.config.ts. But the full deep dive will be in the dedicated State and Configuration pages which I'm gonna add in the next PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants